Skip to content

docs: align README and API docs with current routing/spatial implementation - #13

Merged
blackopsrepl merged 1 commit into
mainfrom
issue/1-docs-align-readme-api-docs
Mar 21, 2026
Merged

docs: align README and API docs with current routing/spatial implementation#13
blackopsrepl merged 1 commit into
mainfrom
issue/1-docs-align-readme-api-docs

Conversation

@blackopsrepl

Copy link
Copy Markdown
Contributor

Summary

  • update README feature and routing claims to match the current K-D tree and zero-heuristic public search behavior
  • clarify which public routing methods are node-snapped versus edge-snapped
  • tighten the public RoadNetwork docs around current geometry semantics

Validation

  • cargo fmt --all -- --check
  • cargo clippy --workspace --all-targets -- -D warnings
  • cargo test --doc --quiet
  • cargo test (blocked by pre-existing integration failures on main: live Overpass fetch failures and OSRM comparison drift)

Fixes #1

@blackopsrepl
blackopsrepl force-pushed the issue/1-docs-align-readme-api-docs branch from 36ac54c to 928c080 Compare March 21, 2026 13:14
@blackopsrepl
blackopsrepl marked this pull request as ready for review March 21, 2026 13:14
@blackopsrepl
blackopsrepl merged commit 0a9f578 into main Mar 21, 2026
@blackopsrepl
blackopsrepl deleted the issue/1-docs-align-readme-api-docs branch April 3, 2026 15:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: align README and API docs with current routing/spatial implementation

1 participant